/* ===========================================================
 * TradeManager : An application to trade strategies for the Java(tm) platform
 * ===========================================================
 *
 * (C) Copyright 2011-2011, by Simon Allen and Contributors.
 *
 * Project Info:  org.trade
 *
 * This library is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
 * (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
 * USA.
 *
 * [Java is a trademark or registered trademark of Oracle, Inc.
 * in the United States and other countries.]
 *
 * (C) Copyright 2011-2011, by Simon Allen and Contributors.
 *
 * Original Author:  Simon Allen;
 * Contributor(s):   -;
 *
 * Changes
 * -------
 *
 */
package org.trade.core.message;

import org.trade.core.exception.ExceptionContext;

/**
 * Exception context is used as the key for retrieving an exception message.
 * Each context can be either a static string from the properties file or a
 * dynamic value filled at runtime by converting an object to a string.
 * 
 * @author Simon Allen
 */
public interface IMessageContextFactory {
	/**
	 * Method create.
	 * 
	 * @return ExceptionContext
	 */
	ExceptionContext create();

	// This is to allow contexts to have dynamic parameters
	/**
	 * Method create.
	 * 
	 * @param context
	 *            ExceptionContext
	 * @return ExceptionContext
	 */
	ExceptionContext create(ExceptionContext context);

	/**
	 * Method create.
	 * 
	 * @param dynamicValue
	 *            Object
	 * @return ExceptionContext
	 */
	ExceptionContext create(Object dynamicValue);
}
